<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>AdWords API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link></head><body><div id="content"><h1 class="file">AdWords/Lib/AdWordsUser.php</h1><div id="file-nav-box"><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
                          Classes
                      </a><ul><li><a href="#\AdWordsUser">\AdWordsUser</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
              Table of Contents
          </div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">User class for the AdWords API to create SOAP clients to the available API
services.</div><div class="long-description"><p>PHP version 5</p>

<p>Copyright 2011, Google Inc. All Rights Reserved.</p>

<p>Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>

<pre><code>http://www.apache.org/licenses/LICENSE-2.0
</code></pre>

<p>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</p></div></div><dl class="file-info"><dt>Author</dt><dd>Adam Rogal
         
    </dd><dt>Author</dt><dd>Eric Koleda
         
    </dd><dt>Author</dt><dd>Vincent Tsao
         
    </dd><dt>Author</dt><dd>Paul Matthews
         
    </dd><dt>Category</dt><dd>WebServices
         
    </dd><dt>Copyright</dt><dd>2011, Google Inc. All Rights Reserved.
         
    </dd><dt>License</dt><dd>http://www.apache.org/licenses/LICENSE-2.0 Apache License,
            Version 2.0
         
    </dd><dt>Package</dt><dd>GoogleApiAdsAdWords
         
    </dd><dt>See</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser">\AdsUser</a>
         
    </dd><dt>Subpackage</dt><dd>Lib
         
    </dd></dl><a name="classes" class="anchor"></a><a id="\AdWordsUser" class="anchor"></a><h2 class="class">\AdWordsUser<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Lib</small><div class="short-description">User class for the AdWords API to create SOAP clients to the available API
services.</div><div class="long-description"></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/Common.Lib.AdsUser.html#\AdsUser">\AdsUser</a></dd></dl><h3>Constants</h3><div><a id="\AdWordsUser::OAUTH2_SCOPE" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> 
                <span class="highlight">OAUTH2_SCOPE</span>
                = 'https://adwords.google.com/api/adwords/'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\AdWordsUser::OAUTH2_HANDLER_CLASS" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> 
                <span class="highlight">OAUTH2_HANDLER_CLASS</span>
                = 'SimpleOAuth2Handler'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\AdWordsUser::USER_AGENT_HEADER_NAME" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>string 
                <span class="highlight">USER_AGENT_HEADER_NAME</span>
                = 'userAgent'</code><div class="description"><div class="short-description">The name of the SOAP header that represents the user agent making API
calls.</div></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt></dt><dd>string<br></br><em></em></dd></dl></div><div class="clear"></div></div></div><h3>Properties</h3><div><a id="\AdWordsUser::$authServer" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$authServer</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$authServer">\AdsUser::$$authServer</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$authServer">\AdsUser::$$authServer</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$defaultServer" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$defaultServer</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$defaultVersion" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$defaultVersion</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$email" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$email</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$libName" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$libName</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$libVersion" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$libVersion</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$logsDirectory" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$logsDirectory</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$logsDirectory">\AdsUser::$$logsDirectory</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$logsDirectory">\AdsUser::$$logsDirectory</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$oauth2Handler" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$oauth2Handler</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$oauth2Handler">\AdsUser::$$oauth2Handler</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$oauth2Handler">\AdsUser::$$oauth2Handler</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$oauth2Info" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$oauth2Info</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$oauth2Info">\AdsUser::$$oauth2Info</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$oauth2Info">\AdsUser::$$oauth2Info</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$password" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$password</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$requestHeaderElements" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$requestHeaderElements</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$requestHeaderElements">\AdsUser::$$requestHeaderElements</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$requestHeaderElements">\AdsUser::$$requestHeaderElements</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$soapCompression" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$soapCompression</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$soapCompression">\AdsUser::$$soapCompression</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$soapCompression">\AdsUser::$$soapCompression</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$soapCompressionLevel" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$soapCompressionLevel</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$soapCompressionLevel">\AdsUser::$$soapCompressionLevel</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$soapCompressionLevel">\AdsUser::$$soapCompressionLevel</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$userAgent" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$userAgent</span></code><div class="description"></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::$wsdlCache" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$wsdlCache</span></code><div class="description"><span class="attribute">inherited</span><small class="inherited_from">Inherited from:
                        <a href="../files/Common.Lib.AdsUser.html#\AdsUser::$$wsdlCache">\AdsUser::$$wsdlCache</a></small></div><div class="code-tabs"><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::$$wsdlCache">\AdsUser::$$wsdlCache</a>
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\AdWordsUser::Define()" class="anchor"></a><div class="method private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">Define</span><span class="nb-faded-text">(string $name, string $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Define a constant if it isn't already defined.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::Define()">\AdsUser::Define()</a></small></div><div class="code-tabs"><div class="long-description"><p>If it is defined but the
value is different then attempt to redefine it, which will fail and throw
the appropriate error.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$name</th><td>string</td><td><em><p>the name of the constant</p></em></td></tr><tr><th>$value</th><td>string</td><td><em><p>the value of the constant</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetAllClientLibraryUserAgentParts()" class="anchor"></a><div class="method private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetAllClientLibraryUserAgentParts</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets all the user agent parts that identify this client library.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetAllClientLibraryUserAgentParts()">\AdsUser::GetAllClientLibraryUserAgentParts()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An array of all the user agent parts that identify this
    client library where each user agent part has been joined by a '/'
    (forward slash).</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetApplicationToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetApplicationToken</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the application token that this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the application token</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetAuthServer()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetAuthServer</span><span class="nb-faded-text">()</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the server used for authentication.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetAuthServer()">\AdsUser::GetAuthServer()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the server used for authentiation</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetAuthToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetAuthToken</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the authentication token.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the auth token</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetAuthVarValue()" class="anchor"></a><div class="method protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">GetAuthVarValue</span><span class="nb-faded-text">(string $authVar, string $authVarName, array $authIni)</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the authenticaiton value for the <var>$authVar</var> supplied.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetAuthVarValue()">\AdsUser::GetAuthVarValue()</a></small></div><div class="code-tabs"><div class="long-description"><p>If
the <var>$authVar</var> is set, it is is used. Otherwise, the supplied
<var>$authenticationIni</var> is queired for the variable. If none is found
<var>NULL</var> is returned.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$authVar</th><td>string</td><td><em><p>the default value for the authenticaiton variable</p></em></td></tr><tr><th>$authVarName</th><td>string</td><td><em><p>the name of the authencation variable</p></em></td></tr><tr><th>$authIni</th><td>array</td><td><em><p>the array of authentication variables from
    an INI file</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the authentication variable value</td></tr></table><strong>Details</strong><dl class="function-info"><dt>Access</dt><dd>protected
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::GetClientCustomerId()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetClientCustomerId</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the client customer ID for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the client customer ID for this user</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetClientLibraryNameAndVersion()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetClientLibraryNameAndVersion</span><span class="nb-faded-text">()</span> : array</code><div class="description"><p class="short_description">Gets the name and version of this client library.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An array containing the name and version of this client
    library, e.g.: ['DfpApi-PHP', '2.13.0'].</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::GetClientLibraryNameAndVersion()">\AdsUser::GetClientLibraryNameAndVersion()</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::GetClientLibraryUserAgent()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetClientLibraryUserAgent</span><span class="nb-faded-text">()</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the user agent string that identifies this library for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetClientLibraryUserAgent()">\AdsUser::GetClientLibraryUserAgent()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>A user agent string.</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetCommonClientLibraryUserAgentParts()" class="anchor"></a><div class="method private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetCommonClientLibraryUserAgentParts</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets common PHP user agent parts for ads client libraries such as PHP
version, operating system, browser, or if compression is being used or not.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetCommonClientLibraryUserAgentParts()">\AdsUser::GetCommonClientLibraryUserAgentParts()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An array of arrays with each inner array representing a user
    agent parts, e.g.: ['PHP', '5.3.2'] or ['PHP', '5.4.0'].</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetDefaultOAuth2Handler()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetDefaultOAuth2Handler</span><span class="nb-faded-text">(NULL | string $className = NULL)</span> : mixed</code><div class="description"><p class="short_description">Get the default OAuth2 Handler for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$className</th><td>NULL | string</td><td><em><p>the name of the oauth2Handler class or NULL</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>the configured OAuth2Handler class</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetDefaultServer()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetDefaultServer</span><span class="nb-faded-text">()</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the default server.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetDefaultServer()">\AdsUser::GetDefaultServer()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the default server</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetDefaultVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetDefaultVersion</span><span class="nb-faded-text">()</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the default version.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetDefaultVersion()">\AdsUser::GetDefaultVersion()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the default version</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetDeveloperToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetDeveloperToken</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the developer token for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the developer token</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetEmail()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetEmail</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the email address of the user login.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the user login email</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetHeaderNames()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetHeaderNames</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the names of all registered request header elements.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetHeaderNames()">\AdsUser::GetHeaderNames()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>the names of the request header elements</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetHeaderValue()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetHeaderValue</span><span class="nb-faded-text">(string $key)</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the value for a registered request header element.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetHeaderValue()">\AdsUser::GetHeaderValue()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$key</th><td>string</td><td><em><p>the name of the request header element</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the value of the request header element or NULL if not found</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetLogsDirectory()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetLogsDirectory</span><span class="nb-faded-text">()</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the logs directory.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetLogsDirectory()">\AdsUser::GetLogsDirectory()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the logs directory</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetOAuth2Handler()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetOAuth2Handler</span><span class="nb-faded-text">()</span> : <a href="../files/Common.Util.OAuth2Handler.html#\OAuth2Handler">\OAuth2Handler</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the OAuth2 handler for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetOAuth2Handler()">\AdsUser::GetOAuth2Handler()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Common.Util.OAuth2Handler.html#\OAuth2Handler">\OAuth2Handler</a></td><td>the OAuth2 handler for this user</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetOAuth2Info()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetOAuth2Info</span><span class="nb-faded-text">()</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the OAuth2 info for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetOAuth2Info()">\AdsUser::GetOAuth2Info()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>the OAuth2 info for this user</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetPassword()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetPassword</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the password for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the password for this user</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetService()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetService</span><span class="nb-faded-text">( $serviceName, string $version = NULL, string $server = NULL, <a href="../files/Common.Lib.SoapClientFactory.html#\SoapClientFactory">\SoapClientFactory</a> $serviceFactory = NULL, bool $validateOnly = NULL, bool $partialFailure = NULL)</span> : <a href="../files/http://php.net/manual/en/class.soapclient.php">\SoapClient</a></code><div class="description"><p class="short_description">Gets the service by its service name and group.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$serviceName</th><td></td><td><em><p>the service name</p></em></td></tr><tr><th>$version</th><td>string</td><td><em><p>the version of the service to get. If
    <var>NULL</var>, then the default version will be used</p>
</em></td></tr><tr><th>$server</th><td>string</td><td><em><p>the server to make the request to. If
    <var>NULL</var>, then the default server will be used</p>
</em></td></tr><tr><th>$serviceFactory</th><td><a href="../files/Common.Lib.SoapClientFactory.html#\SoapClientFactory">\SoapClientFactory</a></td><td><em><p>the factory to create the client.
    If <var>NULL</var>, then the built-in SOAP client factory will be used</p>
</em></td></tr><tr><th>$validateOnly</th><td>bool</td><td><em><p>if the service should be created in validateOnly
    mode</p></em></td></tr><tr><th>$partialFailure</th><td>bool</td><td><em><p>if the service should be created in
    partialFailure mode</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/http://php.net/manual/en/class.soapclient.php">\SoapClient</a></td><td>the instantiated service</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetServiceSoapClient()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetServiceSoapClient</span><span class="nb-faded-text">(string $serviceName, <a href="../files/Common.Lib.SoapClientFactory.html#\SoapClientFactory">\SoapClientFactory</a> $serviceFactory)</span> : <a href="../files/http://php.net/manual/en/class.soapclient.php">\SoapClient</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the service by its service name.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetServiceSoapClient()">\AdsUser::GetServiceSoapClient()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$serviceName</th><td>string</td><td><em><p>the service name</p></em></td></tr><tr><th>$serviceFactory</th><td><a href="../files/Common.Lib.SoapClientFactory.html#\SoapClientFactory">\SoapClientFactory</a></td><td><em><p>the service factory</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/http://php.net/manual/en/class.soapclient.php">\SoapClient</a></td><td>the instantiated service</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetSetting()" class="anchor"></a><div class="method private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetSetting</span><span class="nb-faded-text">(array $settings, string $section, string $name, mixed $default = NULL)</span> : string</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the value for a given setting based on the contents of the parsed INI
file.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetSetting()">\AdsUser::GetSetting()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$settings</th><td>array</td><td><em><p>the parsed settings INI file</p></em></td></tr><tr><th>$section</th><td>string</td><td><em><p>the name of the section containing the setting</p></em></td></tr><tr><th>$name</th><td>string</td><td><em><p>the name of the setting</p></em></td></tr><tr><th>$default</th><td>mixed</td><td><em><p>the default value of the setting</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the value of the setting</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetSoapCompressionLevel()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetSoapCompressionLevel</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the SOAP compression level.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetSoapCompressionLevel()">\AdsUser::GetSoapCompressionLevel()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>int</td><td>the SOAP compression level</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetUserAgent()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetUserAgent</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the raw user agent for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>The raw user agent.</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::GetUserAgentHeaderName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetUserAgentHeaderName</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Gets the appropriate user agent header name for the API this client library
is targeting.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>The user agent header name.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd><a href="../files/
                         Common.Lib.AdsUser.html#\AdsUser::GetUserAgentHeaderName()">\AdsUser::GetUserAgentHeaderName()</a>
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::GetWsdlCacheType()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">GetWsdlCacheType</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Gets the type of WSDL caching in use.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::GetWsdlCacheType()">\AdsUser::GetWsdlCacheType()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>int</td><td>the type of WSDL caching in use</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::InitLogs()" class="anchor"></a><div class="method protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">InitLogs</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Overrides AdsUser::InitLogs(), adding an additional log for report
download requests.</p></div><div class="code-tabs"><div class="long-description"><p>HTTP headers and SOAP XML are logged to the soap_xml.log file and all
request information is logged to the request_info.log file under the logs
directory.</p></div></div><div class="clear"></div></div><a id="\AdWordsUser::IsSoapCompressionEnabled()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">IsSoapCompressionEnabled</span><span class="nb-faded-text">()</span> : bool</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Is SOAP compression enabled.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::IsSoapCompressionEnabled()">\AdsUser::IsSoapCompressionEnabled()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>bool</td><td>is SOAP compression enabled</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::LoadService()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">LoadService</span><span class="nb-faded-text">( $serviceName, string $version = NULL)</span> : void</code><div class="description"><p class="short_description">Loads the classes within a service, so they can be used before the service
is constructed.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$serviceName</th><td></td><td><em><p>the service name</p></em></td></tr><tr><th>$version</th><td>string</td><td><em><p>the version of the service to get. If
    <var>NULL</var>, then the default version will be used</p>
</em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::LoadSettings()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">LoadSettings</span><span class="nb-faded-text">(string $settingsIniPath, string $defaultVersion, string $defaultServer, string $defaultLogsDir, string $logsRelativePathBase)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Loads the settings for this client library.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::LoadSettings()">\AdsUser::LoadSettings()</a></small></div><div class="code-tabs"><div class="long-description"><p>If the settings INI file
located at <var>$settingsIniPath</var> cannot be loaded, then the
parameters passed into this method are used.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$settingsIniPath</th><td>string</td><td><em><p>the path to the settings INI file</p></em></td></tr><tr><th>$defaultVersion</th><td>string</td><td><em><p>the default version if the settings INI file
    cannot be loaded</p></em></td></tr><tr><th>$defaultServer</th><td>string</td><td><em><p>the default server if the settings INI file
    cannot be loaded</p></em></td></tr><tr><th>$defaultLogsDir</th><td>string</td><td><em><p>the default logs directory if the settings
    INI file cannot be loaded</p></em></td></tr><tr><th>$logsRelativePathBase</th><td>string</td><td><em><p>the relative path base for the logs
    directory</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::LogAll()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">LogAll</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Overrides AdsUser::LogAll(), setting an additional log level for report
download requests.</p></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\AdWordsUser::LogDefaults()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">LogDefaults</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Overrides AdsUser::LogDefaults(), setting an additional log level for
report download requests.</p></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\AdWordsUser::LogErrors()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">LogErrors</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Overrides AdsUser::LogErrors(), setting an additional log level for report
download requests.</p></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\AdWordsUser::RegenerateAuthToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">RegenerateAuthToken</span><span class="nb-faded-text">(string $server = NULL)</span> : string</code><div class="description"><p class="short_description">Regenerates the authentication token and sets it for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$server</th><td>string</td><td><em><p>the sever to retrieve the token from</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the newly generated auth token</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetApplicationToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetApplicationToken</span><span class="nb-faded-text">(string $applicationToken)</span> : void</code><div class="description"><p class="short_description">Sets the application token for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$applicationToken</th><td>string</td><td><em><p>the application token</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetAuthToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetAuthToken</span><span class="nb-faded-text">(string $authToken)</span> : void</code><div class="description"><p class="short_description">Sets the authentication token.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$authToken</th><td>string</td><td><em><p>the auth token to set</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetClientCustomerId()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetClientCustomerId</span><span class="nb-faded-text">(string $clientCustomerId)</span> : void</code><div class="description"><p class="short_description">Sets the client customer ID for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$clientCustomerId</th><td>string</td><td><em><p>the client customer ID for this user</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetClientLibraryUserAgent()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetClientLibraryUserAgent</span><span class="nb-faded-text">( $applicationName)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the user agent string that identifies this library for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetClientLibraryUserAgent()">\AdsUser::SetClientLibraryUserAgent()</a></small></div><div class="code-tabs"><div class="long-description"><p>TODO(vtsao): The current contract requires that subclasses call this method
in their constructor.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$applicationName</th><td></td><td><em><p>The application name that will appear in this
    header.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetDefaultServer()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetDefaultServer</span><span class="nb-faded-text">(string $defaultServer)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the default server.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetDefaultServer()">\AdsUser::SetDefaultServer()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$defaultServer</th><td>string</td><td><em><p>the default server</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetDefaultVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetDefaultVersion</span><span class="nb-faded-text">(string $defaultVersion)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the default version.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetDefaultVersion()">\AdsUser::SetDefaultVersion()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$defaultVersion</th><td>string</td><td><em><p>the default version</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetDeveloperToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetDeveloperToken</span><span class="nb-faded-text">(string $developerToken)</span> : void</code><div class="description"><p class="short_description">Sets the developer token for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$developerToken</th><td>string</td><td><em><p>the developer token</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetEmail()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetEmail</span><span class="nb-faded-text">(string $email)</span> : void</code><div class="description"><p class="short_description">Sets the email address of the user login.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$email</th><td>string</td><td><em><p>the user login email</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetHeaderValue()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetHeaderValue</span><span class="nb-faded-text">(string $key, string $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the value for a request header.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetHeaderValue()">\AdsUser::SetHeaderValue()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$key</th><td>string</td><td><em><p>the name of the request header element</p></em></td></tr><tr><th>$value</th><td>string</td><td><em><p>the value for the request header element</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetOAuth2Handler()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetOAuth2Handler</span><span class="nb-faded-text">(array $oauth2Handler)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the OAuth2 handler for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetOAuth2Handler()">\AdsUser::SetOAuth2Handler()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$oauth2Handler</th><td>array</td><td><em><p>the OAuth2 handler for this user</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetOAuth2Info()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetOAuth2Info</span><span class="nb-faded-text">(array $oauth2Info)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Sets the OAuth2 info for this user.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::SetOAuth2Info()">\AdsUser::SetOAuth2Info()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$oauth2Info</th><td>array</td><td><em><p>the OAuth2 info for this user</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetPassword()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetPassword</span><span class="nb-faded-text">(string $password)</span> : void</code><div class="description"><p class="short_description">Sets the password for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$password</th><td>string</td><td><em><p>the password for this user</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::SetUserAgent()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">SetUserAgent</span><span class="nb-faded-text">(string $userAgent)</span> : void</code><div class="description"><p class="short_description">Sets the raw user agent for this user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$userAgent</th><td>string</td><td><em><p>The raw user agent.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::ValidateOAuth2Info()" class="anchor"></a><div class="method protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">ValidateOAuth2Info</span><span class="nb-faded-text">()</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Validates that the OAuth2 info is complete.</p><small class="inherited_from">Inherited from:
                    <a href="../files/Common.Lib.AdsUser.html#\AdsUser::ValidateOAuth2Info()">\AdsUser::ValidateOAuth2Info()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Common.Lib.ValidationException.html#\ValidationException">\ValidationException</a></td><td><em>if there are any validation errors</em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Access</dt><dd>protected
         
    </dd></dl></div><div class="clear"></div></div><a id="\AdWordsUser::ValidateUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">ValidateUser</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">Validates the user and throws a validation error if there are any errors.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Common.Lib.ValidationException.html#\ValidationException">\ValidationException</a></td><td><em>if there are any validation errors</em></td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::__call()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__call</span><span class="nb-faded-text">(string $name, array $arguments)</span> : mixed</code><div class="description"><p class="short_description">Handles calls to undefined methods.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$name</th><td>string</td><td><em><p>the name of the method being called</p></em></td></tr><tr><th>$arguments</th><td>array</td><td><em><p>the arguments passed to the method</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>the result of the correct method call, or nothing if there
    is no correct method</td></tr></table></div><div class="clear"></div></div><a id="\AdWordsUser::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(string $authenticationIniPath = NULL, string $email = NULL, string $password = NULL, string $developerToken = NULL, string $applicationToken = NULL, string $userAgent = NULL, string $clientCustomerId = NULL, string $settingsIniPath = NULL, string $authToken = NULL, array $oauth2Info = NULL)</span> : void</code><div class="description"><p class="short_description">The AdWordsUser constructor.</p></div><div class="code-tabs"><div class="long-description"><p>The AdWordsUser class can be configured in one of two ways:
<ol><li>Using an authenitcation INI file</li>
<li>Using supplied credentials</li></ol></p>

<p>If an authentication INI file is provided and successfully loaded, those
values will be used unless a corresponding parameter overwrites it.
If the authentication INI file is not provided (e.g. it is <var>NULL</var>)
the class will attempt to load the default authentication file at the path
of "../auth.ini" relative to this file's directory. Any corresponding
parameter, which is not <var>NULL</var>, will, however, overwrite any
parameter loaded from the default INI.</p>

<p>Likewise, if a custom settings INI file is not provided, the default
settings INI file will be loaded from the path of "../settings.ini"
relative to this file's directory.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$authenticationIniPath</th><td>string</td><td><em><p>the absolute path to the
    authentication INI or relative to the current directory (cwd). If
    <var>NULL</var>, the default authentication INI file will attempt to be
    loaded</p>
</em></td></tr><tr><th>$email</th><td>string</td><td><em><p>the email of the user (required header). Will
    overwrite the email entry loaded from any INI file</p>
</em></td></tr><tr><th>$password</th><td>string</td><td><em><p>the password of the user (required header). Will
    overwrite the password entry loaded from any INI file</p>
</em></td></tr><tr><th>$developerToken</th><td>string</td><td><em><p>the developer token (required header). Will
    overwrite the developer token entry loaded from any INI file</p>
</em></td></tr><tr><th>$applicationToken</th><td>string</td><td><em><p>the application token (required header).
    Will overwrite the application token entry loaded from any INI file</p>
</em></td></tr><tr><th>$userAgent</th><td>string</td><td><em><p>the user agent name (required header). Will
    be prepended with the library name and version. Will overwrite the
    userAgent entry loaded from any INI file</p>
</em></td></tr><tr><th>$clientCustomerId</th><td>string</td><td><em><p>the client customer ID to make the request
    against (optional header). Will overwrite the clientCustomerId entry
    loaded from any INI file</p>
</em></td></tr><tr><th>$settingsIniPath</th><td>string</td><td><em><p>the path to the settings INI file. If
    <var>NULL</var>, the default settings INI file will be loaded</p>
</em></td></tr><tr><th>$authToken</th><td>string</td><td><em><p>the authToken to use for requests</p></em></td></tr><tr><th>$oauth2Info</th><td>array</td><td><em><p>the OAuth 2.0 information to use for requests</p></em></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
            Documentation was generated by
            <a href="http://phpdoc.org">phpDocumentor
                2.0.0a12</a>.
        </small></body></html>
